Skip to main content
POST
/
public
/
v1
/
invitation-service
/
invitations
[BETA] Invite Vendors
curl --request POST \
  --url https://api.topsort.com/public/v1/invitation-service/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invites": [
    {
      "vendorId": "<string>",
      "vendorEmail": "jsmith@example.com",
      "targetUserRole": "vendor_analyst"
    }
  ]
}
'
import requests

url = "https://api.topsort.com/public/v1/invitation-service/invitations"

payload = { "invites": [
        {
            "vendorId": "<string>",
            "vendorEmail": "jsmith@example.com",
            "targetUserRole": "vendor_analyst"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    invites: [
      {
        vendorId: '<string>',
        vendorEmail: 'jsmith@example.com',
        targetUserRole: 'vendor_analyst'
      }
    ]
  })
};

fetch('https://api.topsort.com/public/v1/invitation-service/invitations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/invitation-service/invitations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'invites' => [
        [
                'vendorId' => '<string>',
                'vendorEmail' => 'jsmith@example.com',
                'targetUserRole' => 'vendor_analyst'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/invitation-service/invitations"

	payload := strings.NewReader("{\n  \"invites\": [\n    {\n      \"vendorId\": \"<string>\",\n      \"vendorEmail\": \"jsmith@example.com\",\n      \"targetUserRole\": \"vendor_analyst\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.topsort.com/public/v1/invitation-service/invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invites\": [\n    {\n      \"vendorId\": \"<string>\",\n      \"vendorEmail\": \"jsmith@example.com\",\n      \"targetUserRole\": \"vendor_analyst\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/invitation-service/invitations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invites\": [\n    {\n      \"vendorId\": \"<string>\",\n      \"vendorEmail\": \"jsmith@example.com\",\n      \"targetUserRole\": \"vendor_analyst\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json
​
invites
VendorInvite · object[]
required

A list of vendors to invite to the Topsort platform. The IDs provided must already exist on the catalog.

Required array length: 1 - 500 elements

Response

Successful Response